Generating Plugin Documentation

Plugin docs in both Confluence and DocBook formats can be generated from plugin descriptor metadata by the plugindoc Maven plugin. Plugin docs will be written under ./target/plugindoc/ - docs will be output in both Confluence and DocBook formats.

Build the Entire Project First

Before you can build the Plugin docs, you must first configure maven, and then build the entire project to generate the plugindoc tool. See Building RHQ for the instructions.

Build the plugindoc Plugin

cd <rhq-trunk>/modules/core/plugindoc
mvn install

Build Plugin Docs for All RHQ Plugins:

cd <rhq-trunk>/modules/plugins
mvn org.rhq:rhq-core-plugindoc:4.5.0-SNAPSHOT:plugindoc -Dmaven.test.skip=true

Automatic Publication To Confluence

To automatically publish generated pages to a Confluence server, add the following properties to an activated profile in your settings.xml before running the plugindoc plugin:

<confluenceUrl>http://rhq-project.org/</confluenceUrl>
<confluenceSpace>JOPR2</confluenceSpace>
<confluenceParentPageTitle>Managed Resources</confluenceParentPageTitle>
<confluenceUserName>yourUsername</confluenceUserName>
<confluencePassword>yourPassword</confluencePassword>